FHIR Server FHIR Server Version n/a

Resource StructureDefinition/FHIR Server from package smart.who.int.trust-phw#current (62 ms)

Package
smart.who.int.trust-phw
Type
StructureDefinition
FHIR Version
Source
http://smart.who.int/trust-phw/https://build.fhir.org/ig/WorldHealthOrganization/smart-trust-phw/StructureDefinition-VerifiableHealthLinkPayload.html
Url
https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload
Version
0.1.0
Status
draft
Date
2025-03-31T23:30:45+00:00
Name
VerifiableHealthLinkPayload
Title
Verifiable Health Link Payload (DRAFT)
Experimental
False
Realm
Authority
who
Description
Verifiable Health Link Payload (DRAFT) This logical model constrains the Health Link Payload for a Verifiable Health Link
Type
https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload
Kind
logical
Resources that use this resource

No resources found
Resources that this resource uses

StructureDefinition
http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload
Health Link Payload (DRAFT)
http://smart.who.int/trust-phw/ValueSet/HL.TYPE
HL.TYPE ValueSet
Narrative

Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition VerifiableHealthLinkPayload
Name	Flags	Card.	Type	Description & Constraints
VerifiableHealthLinkPayload		0..*	HealthLinkPayload	Elements defined in Ancestors:url, key, exp, flag, label, v, type Verifiable Health Link Payload (DRAFT) Instances of this logical model can be the target of a Reference
type	C	1..1	code	Classifying type code to distinguish different types of health links. If not present then the Health Link is a SMART Health Link. Binding: HL.TYPE ValueSet (preferred) is-a-verifiable-health-link: The Health Link type is is a verifiable health link
Documentation for this format
Source

{
  "resourceType" : "StructureDefinition",
  "id" : "VerifiableHealthLinkPayload",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: StructureDefinition VerifiableHealthLinkPayload</b></p><a name=\"VerifiableHealthLinkPayload\"> </a><a name=\"hcVerifiableHealthLinkPayload\"> </a><a name=\"VerifiableHealthLinkPayload-en-US\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"The logical name of the element\">Name</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Flags</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description &amp; Constraints</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-VerifiableHealthLinkPayload-definitions.html#VerifiableHealthLinkPayload\" title=\"Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\n\">VerifiableHealthLinkPayload</a><a name=\"VerifiableHealthLinkPayload\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"StructureDefinition-HealthLinkPayload.html\">HealthLinkPayload</a></td><td style=\"vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><br/>Elements defined in Ancestors:<a href=\"StructureDefinition-HealthLinkPayload.html\" title=\"Manifest URL for this Health Link\">url</a>, <a href=\"StructureDefinition-HealthLinkPayload.html\" title=\"Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.\">key</a>, <a href=\"StructureDefinition-HealthLinkPayload.html\" title=\"Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)\">exp</a>, <a href=\"StructureDefinition-HealthLinkPayload.html\" title=\"Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n\n  \">flag</a>, <a href=\"StructureDefinition-HealthLinkPayload.html\" title=\"Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.\">label</a>, <a href=\"StructureDefinition-HealthLinkPayload.html\" title=\"Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.\">v</a>, <a href=\"StructureDefinition-HealthLinkPayload.html\" title=\"Classifying type code to distinguish different types of health links.  If not present then the Health Link is a SMART Health Link.\">type</a><br/>Verifiable Health Link Payload (DRAFT)<br/><span style=\"font-weight:bold\">Instances of this logical model can be the target of a Reference</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-VerifiableHealthLinkPayload-definitions.html#VerifiableHealthLinkPayload.type\">type</a><a name=\"VerifiableHealthLinkPayload.type\"> </a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;\" href=\"http://hl7.org/fhir/R4/conformance-rules.html#constraints\" title=\"This element has or is affected by constraints ( is-a-verifiable-health-link )\">C</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Classifying type code to distinguish different types of health links.  If not present then the Health Link is a SMART Health Link.</span><br/><span style=\"font-weight:bold\">Binding: </span><a href=\"ValueSet-HL.TYPE.html\" title=\"http://smart.who.int/trust-phw/ValueSet/HL.TYPE\">HL.TYPE ValueSet </a> (<a href=\"http://hl7.org/fhir/R4/terminologies.html#preferred\" title=\"Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.\">preferred</a>)<br/><span style=\"font-weight:bold\">is-a-verifiable-health-link: </span>The Health Link type is is a verifiable health link</td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC\" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
      "valueCode" : "can-be-target"
    }
  ],
  "url" : "https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload",
  "version" : "0.1.0",
  "name" : "VerifiableHealthLinkPayload",
  "title" : "Verifiable Health Link Payload (DRAFT)",
  "status" : "draft",
  "date" : "2025-03-31T23:30:45+00:00",
  "publisher" : "WHO",
  "contact" : [
    {
      "name" : "WHO",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://who.int"
        }
      ]
    }
  ],
  "description" : "Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\n",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "fhirVersion" : "4.0.1",
  "kind" : "logical",
  "abstract" : false,
  "type" : "https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload",
  "baseDefinition" : "http://hl7.org/fhir/uv/smart-health-cards-and-links/StructureDefinition/HealthLinkPayload",
  "derivation" : "specialization",
  "snapshot" : {
    "extension" : [
      {
        "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString" : "0.1.0"
      }
    ],
    "element" : [
      {
        "id" : "VerifiableHealthLinkPayload",
        "path" : "VerifiableHealthLinkPayload",
        "short" : "Verifiable Health Link Payload (DRAFT)",
        "definition" : "Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\n",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Base",
          "min" : 0,
          "max" : "*"
        },
        "isModifier" : false
      },
      {
        "id" : "VerifiableHealthLinkPayload.url",
        "path" : "VerifiableHealthLinkPayload.url",
        "short" : "url",
        "definition" : "Manifest URL for this Health Link",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "HealthLinkPayload.url",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "VerifiableHealthLinkPayload.key",
        "path" : "VerifiableHealthLinkPayload.key",
        "short" : "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.",
        "definition" : "Decryption key for processing files returned in the manifest. 43 characters, consisting of 32 random bytes base64urlencoded.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "HealthLinkPayload.key",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "VerifiableHealthLinkPayload.exp",
        "path" : "VerifiableHealthLinkPayload.exp",
        "short" : "Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)",
        "definition" : "Optional. Number representing expiration time in Epoch seconds, as a hint to help the Health Link Receiving Application determine if this QR is stale. (Note: epoch times should be parsed into 64-bit numeric types.)",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "HealthLinkPayload.exp",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "VerifiableHealthLinkPayload.flag",
        "path" : "VerifiableHealthLinkPayload.flag",
        "short" : "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.\n\n  ",
        "definition" : "Optional. String created by concatenating single-character flags in alphabetical order:\n'L' indicates the Health Link is intended for long-term use and manifest content can evolve over time; \n'P' indicates the Health Link requires a Passcode to resolves; and 'U' indicates the Health Link's url resolves to a single encrypted file accessible via GET, bypassing the manifest and SHALL NOT be used in combination with P.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "HealthLinkPayload.flag",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "VerifiableHealthLinkPayload.label",
        "path" : "VerifiableHealthLinkPayload.label",
        "short" : "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.",
        "definition" : "Optional. String no longer than 80 characters that provides a short description of the data behind the Health Link.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "HealthLinkPayload.label",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "VerifiableHealthLinkPayload.v",
        "path" : "VerifiableHealthLinkPayload.v",
        "short" : "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.",
        "definition" : "Optional. Integer representing the Health Links protocol version this Health Link conforms to. MAY be omitted when the default value (1) applies.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "HealthLinkPayload.v",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "string"
          }
        ]
      },
      {
        "id" : "VerifiableHealthLinkPayload.type",
        "path" : "VerifiableHealthLinkPayload.type",
        "short" : "Classifying type code to distinguish different types of health links.  If not present then the Health Link is a SMART Health Link.",
        "definition" : "Classifying type code to distinguish different types of health links.  If not present then the Health Link is a SMART Health Link.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "HealthLinkPayload.type",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "code"
          }
        ],
        "constraint" : [
          {
            "key" : "is-a-verifiable-health-link",
            "severity" : "error",
            "human" : "The Health Link type is is a verifiable health link",
            "expression" : "type = 'vhl'",
            "source" : "https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload"
          }
        ],
        "binding" : {
          "strength" : "preferred",
          "valueSet" : "http://smart.who.int/trust-phw/ValueSet/HL.TYPE"
        }
      }
    ]
  },
  "differential" : {
    "element" : [
      {
        "id" : "VerifiableHealthLinkPayload",
        "path" : "VerifiableHealthLinkPayload",
        "short" : "Verifiable Health Link Payload (DRAFT)",
        "definition" : "Verifiable Health Link Payload (DRAFT)\n\nThis logical model constrains the Health Link Payload for a Verifiable Health Link\n"
      },
      {
        "id" : "VerifiableHealthLinkPayload.type",
        "path" : "VerifiableHealthLinkPayload.type",
        "min" : 1,
        "constraint" : [
          {
            "key" : "is-a-verifiable-health-link",
            "severity" : "error",
            "human" : "The Health Link type is is a verifiable health link",
            "expression" : "type = 'vhl'",
            "source" : "https://profiles.ihe.net/ITI/VHL/StructureDefinition/VerifiableHealthLinkPayload"
          }
        ],
        "binding" : {
          "strength" : "preferred",
          "valueSet" : "http://smart.who.int/trust-phw/ValueSet/HL.TYPE"
        }
      }
    ]
  }
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.